<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: BOD</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__syspm__functions__bod.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">BOD<div class="ingroups"><a class="el" href="group__group__syspm.html">SysPm        (System Power Management)</a> &raquo; <a class="el" href="group__group__syspm__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga413777ded660fe89b5f9aad08d6b952b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__bod.html#ga413777ded660fe89b5f9aad08d6b952b">Cy_SysPm_BodEnable</a> (<a class="el" href="group__group__syspm__data__enumerates.html#gab8d46ded4cf57ea2c4b365ebc9c6ce30">cy_en_syspm_bod_sel_t</a> bodSel)</td></tr>
<tr class="memdesc:ga413777ded660fe89b5f9aad08d6b952b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables BOD over either VDDD or VDDA or VCCD.  <a href="#ga413777ded660fe89b5f9aad08d6b952b">More...</a><br /></td></tr>
<tr class="separator:ga413777ded660fe89b5f9aad08d6b952b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0b9d1a5605c7cbf9470d86367c5360fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__bod.html#ga0b9d1a5605c7cbf9470d86367c5360fc">Cy_SysPm_BodDisable</a> (<a class="el" href="group__group__syspm__data__enumerates.html#gab8d46ded4cf57ea2c4b365ebc9c6ce30">cy_en_syspm_bod_sel_t</a> bodSel)</td></tr>
<tr class="memdesc:ga0b9d1a5605c7cbf9470d86367c5360fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables BOD over either VDDD or VDDA or VCCD.  <a href="#ga0b9d1a5605c7cbf9470d86367c5360fc">More...</a><br /></td></tr>
<tr class="separator:ga0b9d1a5605c7cbf9470d86367c5360fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6b72592226d8c3d19b862807d5c2acdb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__bod.html#ga6b72592226d8c3d19b862807d5c2acdb">Cy_SysPm_BodVdddSelect</a> (<a class="el" href="group__group__syspm__data__enumerates.html#ga6563c92655e3e272f56c4abc453c7bba">cy_en_syspm_bod_vddd_sel_t</a> bodVdddSel)</td></tr>
<tr class="memdesc:ga6b72592226d8c3d19b862807d5c2acdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects voltage threshold for BOD on VDDD.  <a href="#ga6b72592226d8c3d19b862807d5c2acdb">More...</a><br /></td></tr>
<tr class="separator:ga6b72592226d8c3d19b862807d5c2acdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3c27a998f20f64d7914fdae6704726dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__bod.html#ga3c27a998f20f64d7914fdae6704726dc">Cy_SysPm_BodVddaSelect</a> (<a class="el" href="group__group__syspm__data__enumerates.html#ga46d992cf469c5c6cee4f7d0b01169332">cy_en_syspm_bod_vdda_sel_t</a> bodVddaSel)</td></tr>
<tr class="memdesc:ga3c27a998f20f64d7914fdae6704726dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects voltage threshold for BOD on VDDA.  <a href="#ga3c27a998f20f64d7914fdae6704726dc">More...</a><br /></td></tr>
<tr class="separator:ga3c27a998f20f64d7914fdae6704726dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga29eb146abddee0195f35934dc9ec03e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__bod.html#ga29eb146abddee0195f35934dc9ec03e8">Cy_SysPm_BodActionSelect</a> (<a class="el" href="group__group__syspm__data__enumerates.html#ga9a5991f97a48c172d9815fb64ffd3c3f">cy_en_syspm_bod_action_select_t</a> bodActionSelect)</td></tr>
<tr class="memdesc:ga29eb146abddee0195f35934dc9ec03e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the action taken when the threshold is crossed in the programmed directions(s) for VDDA.  <a href="#ga29eb146abddee0195f35934dc9ec03e8">More...</a><br /></td></tr>
<tr class="separator:ga29eb146abddee0195f35934dc9ec03e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0cab924b8ed6da65736da301d23166ea"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__bod.html#ga0cab924b8ed6da65736da301d23166ea">Cy_SysPm_SupplySupervisionStatus</a> (<a class="el" href="group__group__syspm__data__enumerates.html#ga219c1c0c47a516504e4951a05f38a65d">cy_en_syspm_supply_entity_select_t</a> supplyEntitySelect)</td></tr>
<tr class="memdesc:ga0cab924b8ed6da65736da301d23166ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Supply Status.  <a href="#ga0cab924b8ed6da65736da301d23166ea">More...</a><br /></td></tr>
<tr class="separator:ga0cab924b8ed6da65736da301d23166ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga413777ded660fe89b5f9aad08d6b952b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga413777ded660fe89b5f9aad08d6b952b">&#9670;&nbsp;</a></span>Cy_SysPm_BodEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_BodEnable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gab8d46ded4cf57ea2c4b365ebc9c6ce30">cy_en_syspm_bod_sel_t</a>&#160;</td>
          <td class="paramname"><em>bodSel</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables BOD over either VDDD or VDDA or VCCD. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bodSel</td><td><a class="el" href="group__group__syspm__data__enumerates.html#gab8d46ded4cf57ea2c4b365ebc9c6ce30">cy_en_syspm_bod_sel_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1C devices.</dd>
<dd>
BOD over VDDD and VCCD are enabled by default and cannot be disabled. </dd></dl>

</div>
</div>
<a id="ga0b9d1a5605c7cbf9470d86367c5360fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0b9d1a5605c7cbf9470d86367c5360fc">&#9670;&nbsp;</a></span>Cy_SysPm_BodDisable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_BodDisable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gab8d46ded4cf57ea2c4b365ebc9c6ce30">cy_en_syspm_bod_sel_t</a>&#160;</td>
          <td class="paramname"><em>bodSel</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables BOD over either VDDD or VDDA or VCCD. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bodSel</td><td><a class="el" href="group__group__syspm__data__enumerates.html#gab8d46ded4cf57ea2c4b365ebc9c6ce30">cy_en_syspm_bod_sel_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1C devices.</dd>
<dd>
BOD over VDDD and VCCD are enabled by default and cannot be disabled.</dd>
<dd>
Disabling BOD over VDDA will perform the /ref cy_en_syspm_bod_action_select_t action selected for VDDA. If no action is desired when disabling, firmware must first write CY_SYSPM_BOD_ACTION_NOTHING in a separate write cycle. </dd></dl>

</div>
</div>
<a id="ga6b72592226d8c3d19b862807d5c2acdb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6b72592226d8c3d19b862807d5c2acdb">&#9670;&nbsp;</a></span>Cy_SysPm_BodVdddSelect()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_BodVdddSelect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#ga6563c92655e3e272f56c4abc453c7bba">cy_en_syspm_bod_vddd_sel_t</a>&#160;</td>
          <td class="paramname"><em>bodVdddSel</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Selects voltage threshold for BOD on VDDD. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bodVdddSel</td><td><a class="el" href="group__group__syspm__data__enumerates.html#ga6563c92655e3e272f56c4abc453c7bba">cy_en_syspm_bod_vddd_sel_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1C devices. </dd></dl>

</div>
</div>
<a id="ga3c27a998f20f64d7914fdae6704726dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3c27a998f20f64d7914fdae6704726dc">&#9670;&nbsp;</a></span>Cy_SysPm_BodVddaSelect()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_BodVddaSelect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#ga46d992cf469c5c6cee4f7d0b01169332">cy_en_syspm_bod_vdda_sel_t</a>&#160;</td>
          <td class="paramname"><em>bodVddaSel</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Selects voltage threshold for BOD on VDDA. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bodVddaSel</td><td><a class="el" href="group__group__syspm__data__enumerates.html#ga46d992cf469c5c6cee4f7d0b01169332">cy_en_syspm_bod_vdda_sel_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1C devices. </dd></dl>

</div>
</div>
<a id="ga29eb146abddee0195f35934dc9ec03e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga29eb146abddee0195f35934dc9ec03e8">&#9670;&nbsp;</a></span>Cy_SysPm_BodActionSelect()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_BodActionSelect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#ga9a5991f97a48c172d9815fb64ffd3c3f">cy_en_syspm_bod_action_select_t</a>&#160;</td>
          <td class="paramname"><em>bodActionSelect</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the action taken when the threshold is crossed in the programmed directions(s) for VDDA. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bodActionSelect</td><td><a class="el" href="group__group__syspm__data__enumerates.html#ga9a5991f97a48c172d9815fb64ffd3c3f">cy_en_syspm_bod_action_select_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1C devices.</dd>
<dd>
This API is not applicable for selectng actions for VDDD and VCCD as the default action is RESET for them. </dd></dl>

</div>
</div>
<a id="ga0cab924b8ed6da65736da301d23166ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0cab924b8ed6da65736da301d23166ea">&#9670;&nbsp;</a></span>Cy_SysPm_SupplySupervisionStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysPm_SupplySupervisionStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#ga219c1c0c47a516504e4951a05f38a65d">cy_en_syspm_supply_entity_select_t</a>&#160;</td>
          <td class="paramname"><em>supplyEntitySelect</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Supply Status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">supplyEntitySelect</td><td><a class="el" href="group__group__syspm__data__enumerates.html#ga219c1c0c47a516504e4951a05f38a65d">cy_en_syspm_supply_entity_select_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>State of BOD/OVD on VDDD/VDDA/VCCD, whether OK or Not OK</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1C devices. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
